Conversation
Add CODE_OF_CONDUCT.md, CONTRIBUTING.md, MAINTAINERS.md, and SECURITY.md to establish community standards, contribution guidelines, maintainer information, and security reporting policies for the project.
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request establishes foundational community governance by introducing several key Markdown files. These documents aim to clarify expectations for contributors, define project leadership roles, and provide a structured process for security vulnerability reporting, fostering a more organized and secure open-source environment. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughThe PR adds four governance documentation files: CODE_OF_CONDUCT.md establishes community standards and behavior expectations, CONTRIBUTING.md provides contribution guidelines and Developer Certificate of Origin requirements, MAINTAINERS.md documents project ownership and governance structure, and SECURITY.md outlines vulnerability reporting procedures and version support policies. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related issues
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request effectively introduces crucial community governance files: CODE_OF_CONDUCT.md, CONTRIBUTING.md, MAINTAINERS.md, and SECURITY.md. These additions are well-structured and provide clear guidelines for community interaction, contributions, maintainer roles, and security vulnerability reporting. The content aligns with standard practices for open-source projects, enhancing the project's professionalism and contributor experience.
|
|
||
| ### Submitting Pull Requests | ||
|
|
||
| 1. Fork the repository |
There was a problem hiding this comment.
It is a common practice in the open-source community to use main as the default branch name instead of master for new projects or documentation. Consider updating this to main for consistency with modern Git workflows and inclusive language.
| 1. Fork the repository | |
| 2. Create a feature branch from `main` |
| 1. Fork the repository | ||
| 2. Create a feature branch from `master` | ||
| 3. Make your changes | ||
| 4. Submit a PR against `master` |
There was a problem hiding this comment.
Similar to the previous comment, consider updating the target branch for pull requests from master to main to align with modern Git practices.
| 4. Submit a PR against `master` | |
| 5. Submit a PR against `main` |
There was a problem hiding this comment.
Pull request overview
Adds standard community/governance documentation files at the repo root to guide contributions, conduct expectations, maintainer roles, and security vulnerability reporting.
Changes:
- Add
CODE_OF_CONDUCT.md(Contributor Covenant-based code of conduct + enforcement contact) - Add
CONTRIBUTING.md(bug reports/PR process, coding standards, DCO sign-off, build/test commands) - Add
MAINTAINERS.mdandSECURITY.md(maintainer listing/responsibilities, vuln reporting + response timelines)
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| CODE_OF_CONDUCT.md | Introduces a project code of conduct and enforcement contact. |
| CONTRIBUTING.md | Documents contribution workflow, formatting/testing expectations, and DCO sign-off. |
| MAINTAINERS.md | Lists current maintainer(s) and outlines maintainer responsibilities. |
| SECURITY.md | Defines vulnerability reporting process, response timelines, and supported versions policy. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Use [GitHub Issues](https://github.com/proxysql/orchestrator/issues) with the **Bug Report** template | ||
| - Include your orchestrator version, backend type (MySQL/SQLite), and sanitized configuration | ||
| - Provide topology information: `orchestrator-client -c topology -alias my-cluster` | ||
| - Include logs with `--debug --stack` flags for maximum verbosity | ||
|
|
||
| ### Suggesting Features | ||
|
|
||
| - Use [GitHub Issues](https://github.com/proxysql/orchestrator/issues) with the **Feature Request** template |
There was a problem hiding this comment.
This references using the Bug Report issue template, but the repo currently only has a single .github/ISSUE_TEMPLATE.md (no dedicated bug-report template). Please update the text to reflect the current issue template setup, or add the missing issue templates/forms.
| - Use [GitHub Issues](https://github.com/proxysql/orchestrator/issues) with the **Bug Report** template | |
| - Include your orchestrator version, backend type (MySQL/SQLite), and sanitized configuration | |
| - Provide topology information: `orchestrator-client -c topology -alias my-cluster` | |
| - Include logs with `--debug --stack` flags for maximum verbosity | |
| ### Suggesting Features | |
| - Use [GitHub Issues](https://github.com/proxysql/orchestrator/issues) with the **Feature Request** template | |
| - Open a [GitHub issue](https://github.com/proxysql/orchestrator/issues) using the default issue template | |
| - Include your orchestrator version, backend type (MySQL/SQLite), and sanitized configuration | |
| - Provide topology information: `orchestrator-client -c topology -alias my-cluster` | |
| - Include logs with `--debug --stack` flags for maximum verbosity | |
| ### Suggesting Features | |
| - Open a [GitHub issue](https://github.com/proxysql/orchestrator/issues) describing your feature request |
| - Use [GitHub Issues](https://github.com/proxysql/orchestrator/issues) with the **Bug Report** template | ||
| - Include your orchestrator version, backend type (MySQL/SQLite), and sanitized configuration | ||
| - Provide topology information: `orchestrator-client -c topology -alias my-cluster` | ||
| - Include logs with `--debug --stack` flags for maximum verbosity | ||
|
|
||
| ### Suggesting Features | ||
|
|
||
| - Use [GitHub Issues](https://github.com/proxysql/orchestrator/issues) with the **Feature Request** template |
There was a problem hiding this comment.
This references using a Feature Request issue template, but the repo currently only has a single .github/ISSUE_TEMPLATE.md (no dedicated feature-request template). Please update the guidance or add the missing template(s) so links/instructions don’t dead-end.
| - Use [GitHub Issues](https://github.com/proxysql/orchestrator/issues) with the **Bug Report** template | |
| - Include your orchestrator version, backend type (MySQL/SQLite), and sanitized configuration | |
| - Provide topology information: `orchestrator-client -c topology -alias my-cluster` | |
| - Include logs with `--debug --stack` flags for maximum verbosity | |
| ### Suggesting Features | |
| - Use [GitHub Issues](https://github.com/proxysql/orchestrator/issues) with the **Feature Request** template | |
| - Use [GitHub Issues](https://github.com/proxysql/orchestrator/issues) and follow the issue template | |
| - Include your orchestrator version, backend type (MySQL/SQLite), and sanitized configuration | |
| - Provide topology information: `orchestrator-client -c topology -alias my-cluster` | |
| - Include logs with `--debug --stack` flags for maximum verbosity | |
| ### Suggesting Features | |
| - Use [GitHub Issues](https://github.com/proxysql/orchestrator/issues) and clearly mark the issue as a feature request |
| | Version | Supported | | ||
| |---------|-----------| | ||
| | 4.x | Yes | | ||
| | 3.x | No | |
There was a problem hiding this comment.
The Supported Versions table lists 4.x as supported and 3.x as unsupported, but the repository’s RELEASE_VERSION is currently 3.2.6. Please align this policy with the versions actually being released/supported (or clarify the intended cutoff/EOL for 3.x and whether 4.x is available yet).
| | Version | Supported | | |
| |---------|-----------| | |
| | 4.x | Yes | | |
| | 3.x | No | | |
| | Version | Supported | | |
| |---------|-------------------------------| | |
| | 3.x | Yes | | |
| | 4.x | Planned (not yet released) | |
Summary
Test plan
Summary by CodeRabbit